<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//ZH-CN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
	<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
	<meta http-equiv="imagetoolbar" content="no" />
	<title>Class UI.ListView</title>
	<link href="../resources/API_Help.css" type="text/css" rel="stylesheet" />
</head>

<body>
<!--打印本页-->
<div class="printCurrentPage">
	<img src="../resources/image/print.gif" align="absmiddle" />&nbsp;
	<a href="ui_ListView_API.html" target="_blank">打印本页</a>
</div><br/>

<!--标题说明-->
<h1>Class UI.ListView</h1>
<b>定义于文件：</b>&nbsp;&nbsp;webui.js
<div class="description">将页面对象渲染成列表框控件。</div><br/>
<b>基本语法</b>
<div class="syntax">var listView = new <b>UI.ListView</b>( { &lt; <em>id:String|Tag</em>,&nbsp;&nbsp;<em>name:String</em> &gt; [ , <em>width:Number</em>,&nbsp;&nbsp;<em>row:Number</em> ] } );</div>
<b>参数说明</b>
<div class="parameter">
	<ul>
		<li><em>id</em> : String|Tag</li>
		<div class="subDesc">页面列表框标签ID或是页面列表框标签对象。</div>
		<li><em>name</em> : String</li>
		<div class="subDesc">列表框的名字, 提交时, 后台通过列表框的名字取得列表框的值, 默认值：id。</div>
		<li><em>width</em> : Number</li>
		<div class="subDesc">(可选参数) 列表框的宽度, 默认值：160px。</div>
		<li><em>row</em> : Number</li>
		<div class="subDesc">(可选参数) 列表框的最大显示行数, 默认值：5。</div>
	</ul>
</div>
<b>页面标签对象原型</b>
<div class="parameter">
	&lt;select&gt;&lt;/select&gt;
</div>
<b>依赖关系</b>
<div class="parameter">
	<a href="core_API.html">core.js</a>
</div><br/>
<a href="#properties">相关属性</a>&nbsp;&nbsp;-&nbsp;&nbsp;
<a href="#methods">相关方法</a>&nbsp;&nbsp;-&nbsp;&nbsp;
<a href="#events">相关事件</a>&nbsp;&nbsp;-&nbsp;&nbsp;
<a href="#examples">应用示例</a>
<hr>

<!--相关属性-->
<a name="properties"></a>
<h2>相关属性</h2>
<table width="100%" cellspacing="0">
	<tbody>
		<tr>
			<td class="tableHead" width="83%">所有属性</td>
			<td class="tableHead" width="17%">所属类</td>
		</tr>
		<tr>
			<td class="tableLineLeft">
				<a href="#UI.ListView.dom" class="methodLink">UI.ListView.dom</a>&nbsp;:&nbsp;&lt;div&gt;<br/>
				列表框控件的页面标签对象。
			</td><td class="tableLineRight">UI.ListView</td>
		</tr>
		<tr>
			<td class="tableLineLeft alt">
				<a href="#UI.ListView.selectIndex" class="methodLink">UI.ListView.selectIndex</a>&nbsp;:&nbsp;Number<br/>
				列表框控件当前处于选择状态的成员索引号。
			</td><td class="tableLineRight alt">UI.ListView</td>
		</tr>
	</tbody>
</table>

<!--相关方法-->
<a name="methods"></a>
<h2>相关方法</h2>
<table width="100%" cellspacing="0">
	<tbody>
		<tr>
			<td class="tableHead" width="83%">所有方法</td>
			<td class="tableHead" width="17%">所属类</td>
		</tr>
		<tr>
			<td class="tableLineLeft">
				<a href="#addItem" class="methodLink">addItem</a>( <em>text:String</em>,&nbsp;&nbsp;<em>value:String</em> )&nbsp;:&nbsp;none<br/>
				向列表框控件中添加一个新的 item 成员。
			</td><td class="tableLineRight">UI.ListView</td>
		</tr>
		<tr>
			<td class="tableLineLeft alt">
				<a href="#disable" class="methodLink">disable</a>( <em>disable:boolean</em> )&nbsp;:&nbsp;none<br/>
				设置列表框是否可用。
			</td><td class="tableLineRight alt">UI.ListView</td>
		</tr>
		<tr>
			<td class="tableLineLeft">
				<a href="#fillData" class="methodLink">fillData</a>( <em>texts:Array</em>,&nbsp;&nbsp;<em>values:Array</em> )&nbsp;:&nbsp;none<br/>
				向列表框控件中添加多个 item 成员。
			</td><td class="tableLineRight">UI.ListView</td>
		</tr>
		<tr>
			<td class="tableLineLeft alt">
				<a href="#getIndexByText" class="methodLink">getIndexByText</a>( <em>text:String</em> )&nbsp;:&nbsp;Number<br/>
				返回显示文本为 text 的成员索引号。
			</td><td class="tableLineRight alt">UI.ListView</td>
		</tr>
		<tr>
			<td class="tableLineLeft">
				<a href="#getIndexByValue" class="methodLink">getIndexByValue</a>( <em>value:String</em> )&nbsp;:&nbsp;Number<br/>
				返回值为 value 的成员索引号。
			</td><td class="tableLineRight">UI.ListView</td>
		</tr>
		<tr>
			<td class="tableLineLeft alt">
				<a href="#getText" class="methodLink">getText</a>()&nbsp;:&nbsp;String<br/>
				返回列表框当前处于选择状态的成员的显示文本。
			</td><td class="tableLineRight alt">UI.ListView</td>
		</tr>
		<tr>
			<td class="tableLineLeft">
				<a href="#getValue" class="methodLink">getValue</a>()&nbsp;:&nbsp;String<br/>
				返回列表框当前的值。
			</td><td class="tableLineRight">UI.ListView</td>
		</tr>
		<tr>
			<td class="tableLineLeft alt">
				<a href="#onChange" class="methodLink">onChange</a>( <em>callBack:Function</em> )&nbsp;:&nbsp;none<br/>
				设置列表框控件的动作事件回调。 
			</td><td class="tableLineRight alt">UI.ListView</td>
		</tr>
		<tr>
			<td class="tableLineLeft">
				<a href="#onDblClick" class="methodLink">onDblClick</a>( <em>callBack:Function</em> )&nbsp;:&nbsp;none<br/>
				设置列表框控件的双击动作事件回调。 
			</td><td class="tableLineRight">UI.ListView</td>
		</tr>
		<tr>
			<td class="tableLineLeft alt">
				<a href="#removeAll" class="methodLink">removeAll</a>()&nbsp;:&nbsp;none<br/>
				删除列表框控件中的所有 item 成员。
			</td><td class="tableLineRight alt">UI.ListView</td>
		</tr>
		<tr>
			<td class="tableLineLeft">
				<a href="#removeItem" class="methodLink">removeItem</a>( <em>index:Number</em> )&nbsp;:&nbsp;none<br/>
				删除列表框控件中 index 索引所对应的item成员。
			</td><td class="tableLineRight">UI.ListView</td>
		</tr>
		<tr>
			<td class="tableLineLeft alt">
				<a href="#setValue" class="methodLink">setValue</a>( <em>value:String</em> )&nbsp;:&nbsp;none<br/>
				设置列表框的值, 并将 value 所对应的 item 成员设置为选择状态。
			</td><td class="tableLineRight alt">UI.ListView</td>
		</tr>
	</tbody>
</table>

<!--相关事件-->
<a name="events"></a>
<h2>相关事件</h2>
<table width="100%" cellspacing="0">
	<tbody>
		<tr>
			<td class="tableHead" width="83%">所有事件</td>
			<td class="tableHead" width="17%">所属类</td>
		</tr>
		<tr>
			<td class="tableLineLeft">
				<a href="#UI.ListView.onChangeEvent" class="methodLink">UI.ListView.onChangeEvent</a>&nbsp;:&nbsp;Function<br/>
				列表框控件选择状态改变的动作事件。
			</td><td class="tableLineRight">UI.ListView</td>
		</tr>
		<tr>
			<td class="tableLineLeft alt">
				<a href="#UI.ListView.onDblClickEvent" class="methodLink">UI.ListView.onDblClickEvent</a>&nbsp;:&nbsp;Function<br/>
				列表框控件成员的双击动作事件。
			</td><td class="tableLineRight alt">UI.ListView</td>
		</tr>
	</tbody>
</table>
<br/>

<hr>

<!--相关属性的详细说明-->
<h2>本类属性的详细说明</h2>
<div class="detailWrap">

<a name="UI.ListView.dom"></a>
<div class="mdetail">
	<h3>UI.ListView.dom</h3><br/>
	<div class="mdetailDetails">
		列表框控件的页面标签对象。<br/>
		通过 dom 属性可直接对列表框进行操作。
	</div>
	<div class="footer since">@since JSR2.0&nbsp;&nbsp;&nbsp;&nbsp;<a href="ui_ListView_API.html">Return</a></div><br/>
</div>

<a name="UI.ListView.selectIndex"></a>
<div class="mdetail alt">
	<h3>UI.ListView.selectIndex</h3><br/>
	<div class="mdetailDetails">
		列表框控件当前处于选择状态的成员索引号。<br/>
		通过 selectIndex 属性可获得列表框当前的选择状态。
	</div>
	<div class="footer since">@since JSR2.0&nbsp;&nbsp;&nbsp;&nbsp;<a href="ui_ListView_API.html">Return</a></div><br/>
</div>

</div><br/>

<!--相关方法的详细说明-->
<h2>本类方法的详细说明</h2>
<div class="detailWrap">

<a name="addItem"></a>
<div class="mdetail">
	<h3>addItem</h3>
	<div class="functionDefine">public function addItem( text:String, value:String )</div>
	<div class="mdetailDetails">
		向列表框控件中添加一个新的 item 成员。<br/>
	</div><br/>
	<div class="mdetailDetails"><b>参数</b>
		<ul>
			<li><em>text</em> : String</li>
			<div class="subDesc">新成员的显示文本。</div>
			<li><em>value</em> : String</li>
			<div class="subDesc">新成员的值, 当 value 缺省时, 默认取 text 的值</div>
		</ul>
		<b>返回值</b>
		<ul><li>无</li></ul>
	</div>
	<div class="footer since">@since JSR2.0&nbsp;&nbsp;&nbsp;&nbsp;<a href="ui_ListView_API.html">Return</a></div><br/>
</div>

<a name="disable"></a>
<div class="mdetail alt">
	<h3>disable</h3>
	<div class="functionDefine">public function disable( disable:boolean )</div>
	<div class="mdetailDetails">
		设置列表框是否可用。
	</div><br/>
	<div class="mdetailDetails"><b>参数</b>
		<ul>
			<li><em>disable</em> : boolean</li>
			<div class="subDesc">参数的取值&nbsp;&nbsp;&nbsp;&nbsp;true: 不可用, false: 可用。</div>
		</ul>
		<b>返回值</b>
		<ul><li>无</li></ul>
	</div>
	<div class="footer since">@since JSR2.0&nbsp;&nbsp;&nbsp;&nbsp;<a href="ui_ListView_API.html">Return</a></div><br/>
</div>

<a name="fillData"></a>
<div class="mdetail">
	<h3>fillData</h3>
	<div class="functionDefine">public function fillData( texts:Array, values:Array )</div>
	<div class="mdetailDetails">
		向列表框控件中添加多个 item 成员。<br/>本方法是先将列表框原有成员清空后，再添加新的 item 成员。
	</div><br/>
	<div class="mdetailDetails"><b>参数</b>
		<ul>
			<li><em>texts</em> : Array</li>
			<div class="subDesc">新成员的显示文本集合。</div>
			<li><em>values</em> : Array</li>
			<div class="subDesc">新成员的值集合</div>
		</ul>
		<b>返回值</b>
		<ul><li>无</li></ul>
	</div>
	<div class="footer since">@since JSR2.0&nbsp;&nbsp;&nbsp;&nbsp;<a href="ui_ListView_API.html">Return</a></div><br/>
</div>

<a name="getIndexByText"></a>
<div class="mdetail alt">
	<h3>getIndexByText</h3>
	<div class="functionDefine">public function getIndexByText( text:String )</div>
	<div class="mdetailDetails">返回显示文本为 text 的成员索引号, 如果 text 没有对应的 item 项, 则返回 -1。</div><br/>
	<div class="mdetailDetails"><b>参数</b>
		<ul>
			<li><em>text</em> : String</li>
			<div class="subDesc">成员显示文本。</div>
		</ul>
		<b>返回值</b>
		<ul><li>Number</li></ul>
	</div>
	<div class="footer since">@since JSR2.0&nbsp;&nbsp;&nbsp;&nbsp;<a href="ui_ListView_API.html">Return</a></div><br/>
</div>

<a name="getIndexByValue"></a>
<div class="mdetail">
	<h3>getIndexByValue</h3>
	<div class="functionDefine">public function getIndexByValue( value:String )</div>
	<div class="mdetailDetails">返回值为 value 的成员索引号, 如果 value 没有对应的 item 项, 则返回 -1。</div><br/>
	<div class="mdetailDetails"><b>参数</b>
		<ul>
			<li><em>value</em> : String</li>
			<div class="subDesc">成员的值。</div>
		</ul>
		<b>返回值</b>
		<ul><li>Number</li></ul>
	</div>
	<div class="footer since">@since JSR2.0&nbsp;&nbsp;&nbsp;&nbsp;<a href="ui_ListView_API.html">Return</a></div><br/>
</div>

<a name="getText"></a>
<div class="mdetail alt">
	<h3>getText</h3>
	<div class="functionDefine">public function getText()</div>
	<div class="mdetailDetails">返回列表框当前处于选择状态的成员的显示文本。</div><br/>
	<div class="mdetailDetails"><b>参数</b>
		<ul><li>无</li></ul>
		<b>返回值</b>
		<ul><li>String</li></ul>
	</div>
	<div class="footer since">@since JSR2.0&nbsp;&nbsp;&nbsp;&nbsp;<a href="ui_ListView_API.html">Return</a></div><br/>
</div>

<a name="getValue"></a>
<div class="mdetail">
	<h3>getValue</h3>
	<div class="functionDefine">public function getValue()</div>
	<div class="mdetailDetails">返回列表框当前的值。</div><br/>
	<div class="mdetailDetails"><b>参数</b>
		<ul><li>无</li></ul>
		<b>返回值</b>
		<ul><li>String</li></ul>
	</div>
	<div class="footer since">@since JSR2.0&nbsp;&nbsp;&nbsp;&nbsp;<a href="ui_ListView_API.html">Return</a></div><br/>
</div>

<a name="onChange"></a>
<div class="mdetail alt">
	<h3>onChange</h3>
	<div class="functionDefine">public function onChange( callBack:Function )</div>
	<div class="mdetailDetails">设置列表框的 onChangeEvent 动作事件回调。<br/>
	当事件触发时, 系统会自动调用 callBack 方法。</div><br/>
	<div class="mdetailDetails"><b>参数</b>
		<ul>
			<li><em>callBack</em> : Function</li>
			<div class="subDesc">回调函数名。</div>
		</ul>
		<b>返回值</b>
		<ul><li>无</li></ul>
	</div>
	<div class="footer since">@since JSR2.0&nbsp;&nbsp;&nbsp;&nbsp;<a href="ui_ListView_API.html">Return</a></div><br/>
</div>

<a name="onDblClick"></a>
<div class="mdetail">
	<h3>onDblClick</h3>
	<div class="functionDefine">public function onDblClick( callBack:Function )</div>
	<div class="mdetailDetails">设置列表框的 onDblClickEvent 动作事件回调。<br/>
	当事件触发时, 系统会自动调用 callBack 方法。</div><br/>
	<div class="mdetailDetails"><b>参数</b>
		<ul>
			<li><em>callBack</em> : Function</li>
			<div class="subDesc">回调函数名。</div>
		</ul>
		<b>返回值</b>
		<ul><li>无</li></ul>
	</div>
	<div class="footer since">@since JSR2.0&nbsp;&nbsp;&nbsp;&nbsp;<a href="ui_ListView_API.html">Return</a></div><br/>
</div>

<a name="removeAll"></a>
<div class="mdetail alt">
	<h3>removeAll</h3>
	<div class="functionDefine">public function removeAll()</div>
	<div class="mdetailDetails">删除列表框控件中的所有 item 成员。</div><br/>
	<div class="mdetailDetails"><b>参数</b>
		<ul><li>无</li></ul>
		<b>返回值</b>
		<ul><li>无</li></ul>
	</div>
	<div class="footer since">@since JSR2.0&nbsp;&nbsp;&nbsp;&nbsp;<a href="ui_ListView_API.html">Return</a></div><br/>
</div>

<a name="removeItem"></a>
<div class="mdetail">
	<h3>removeItem</h3>
	<div class="functionDefine">public function removeItem( index:Number )</div>
	<div class="mdetailDetails">删除列表框控件中 index 索引所对应的 item 成员, 如果 index 不合法将不做任何操作。</div><br/>
	<div class="mdetailDetails"><b>参数</b>
		<ul>
			<li><em>index</em> : Number</li>
			<div class="subDesc">成员对象的索引号。</div>
		</ul>
		<b>返回值</b>
		<ul><li>无</li></ul>
	</div>
	<div class="footer since">@since JSR2.0&nbsp;&nbsp;&nbsp;&nbsp;<a href="ui_ListView_API.html">Return</a></div><br/>
</div>

<a name="setValue"></a>
<div class="mdetail alt">
	<h3>setValue</h3>
	<div class="functionDefine">public function setValue( value:String )</div>
	<div class="mdetailDetails">设置列表框的值, 并将 value 所对应的 item 成员设置为选择状态, 如果 value 无对应的成员, 则不做任何操作。</div><br/>
	<div class="mdetailDetails"><b>参数</b>
		<ul>
			<li><em>value</em> : String</li>
			<div class="subDesc">item成员的值。</div>
		</ul>
		<b>返回值</b>
		<ul><li>无</li></ul>
	</div>
	<div class="footer since">@since JSR2.0&nbsp;&nbsp;&nbsp;&nbsp;<a href="ui_ListView_API.html">Return</a></div><br/>
</div>

</div><br/>

<!--相关事件的详细说明-->
<h2>本类事件的详细说明</h2>
<div class="detailWrap">

<a name="UI.ListView.onChangeEvent"></a>
<div class="mdetail">
	<h3>UI.ListView.onChangeEvent</h3><br/>
	<div class="mdetailDetails">
		列表框控件选择状态改变的动作事件。<br/>
		在改变列表框的选择状态时将会触发此事件, 具体的应用请参见方法 <a href="#onChange" class="methodLink">onChange</a> 的说明。
	</div>
	<div class="footer since">@since JSR2.0&nbsp;&nbsp;&nbsp;&nbsp;<a href="ui_ListView_API.html">Return</a></div><br/>
</div>

<a name="UI.ListView.onDblClickEvent"></a>
<div class="mdetail alt">
	<h3>UI.ListView.onDblClickEvent</h3><br/>
	<div class="mdetailDetails">
		列表框控件的成员双击动作事件。<br/>
		在双击列表框的成员项时将会触发此事件, 具体的应用请参见方法 <a href="#onDblClick" class="methodLink">onDblClick</a> 的说明。
	</div>
	<div class="footer since">@since JSR2.0&nbsp;&nbsp;&nbsp;&nbsp;<a href="ui_ListView_API.html">Return</a></div><br/>
</div>
</div><br/>

<!--应用示例-->
<a name="examples"></a>
<h2>应用示例</h2>
<div class="properties"><a href="../Example/ui_ListView.html" target="_blank">ui_ListView.html</a></div><br/>

<!--页脚-->
<hr>
<div class="footer">JSR - Copyright &copy; 2007-2008 Jsr JS, LLC<br/>All rights reserved.</div>
</body>
</html>
